Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix broken test running documentation #1214

Closed
wants to merge 1 commit into from
Closed

Fix broken test running documentation #1214

wants to merge 1 commit into from

Conversation

drichardson
Copy link

@drichardson drichardson commented Dec 14, 2024 •
edited
Loading

Background

The documented steps to run tests say to

python setup.py test

However, that results in

$ python setup.py test
usage: setup.py [global_opts] cmd1 [cmd1_opts] [cmd2 [cmd2_opts] ...]
   or: setup.py --help [cmd1 cmd2 ...]
   or: setup.py --help-commands
   or: setup.py cmd --help

error: invalid command 'test'

However, the make test target works.

Changes

  1. Reference make test for running tests
  2. For consistency, also updated build and build debug commands in Building from source to use make and make debug.

Testing

Ran make htmldocs and verified output was correct. Only minor weirdness was the green syntax highlighting on test in make test (perhaps because it's a built in bash command).

Screenshot of rendered HTML:

Screenshot 2024-12-14 at 11 39 45

@drichardson drichardson marked this pull request as ready for review December 14, 2024 19:41
@drichardson drichardson changed the title Fix broken docs Fix broken test running documentation Dec 14, 2024
elprans
elprans reviewed Dec 18, 2024
View reviewed changes
Copy link
Member

@elprans elprans left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@drichardson
Copy link
Author

@elprans do you have permission to re-trigger a github Action run on this failed job (I'm guessing it's flaky since mine was only a documentation change).

======================================================================
FAIL: test_pool_max_inactive_time_04 (test_pool.TestPool)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "D:\a\asyncpg\asyncpg\asyncpg\_testbase\__init__.py", line 453, in tearDown
    super().tearDown()
  File "D:\a\asyncpg\asyncpg\asyncpg\_testbase\__init__.py", line 369, in tearDown
    super().tearDown()
  File "D:\a\asyncpg\asyncpg\asyncpg\_testbase\__init__.py", line 138, in tearDown
    self.fail(
AssertionError: unexpected exceptions in asynchronous code:
01. Exception in callback _ProactorBasePipeTransport._call_connection_lost(None):
    [handle]: <Handle _ProactorBasePipeTransport._call_connection_lost(None)>

    [exception]:
      Traceback (most recent call last):
        File "C:\hostedtoolcache\windows\Python\3.9.13\x64\lib\asyncio\events.py", line 80, in _run
          self._context.run(self._callback, *self._args)
        File "C:\hostedtoolcache\windows\Python\3.9.13\x64\lib\asyncio\proactor_events.py", line 162, in _call_connection_lost
          self._sock.shutdown(socket.SHUT_RDWR)
      ConnectionResetError: [WinError 10054] An existing connection was forcibly closed by the remote host

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@elprans elprans elprans left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@drichardson @elprans